Help:Piped link
From PyroGuide
Contents |
A piped link is a link within the project or to a sister project which is labeled differently from the name of the page it links to. This allows linking a word or phrase within the text of a page rather than using "see also", even if the wording does not exactly correspond with the name of the other page. With a suitable browser and depending on the preferences set, one can still see what page is linked to: when you point at the link, the name shows up in a hover box and is also shown in the status bar.
For instance:
[[coffeehouse setup|How to set up a coffee house]]
will show: How to set up a coffee house
The term piped refers to the use of the pipe character "|" used to separate the good description from the actual link. This character is named after an alternative use of it; see Pipe (computing).
Another example would be [[train station|station]] rendering as station. This is useful where the word "station" is used in an article on trains; from the context, it would be clear that a train station is meant. The piped link is more convenient to the user than a link to station which might be a disambiguation page.
[edit] Using a redirect as an alternative
An alternative is simply using [[How to set up a coffee house]] to create How to set up a coffee house (note that, unlike above, what pops up when you point at the link, if applicable for your browser, is simply the text already shown), and making How to set up a coffee house a redirect page.
This is convenient if the redirect is already there or will also be of use elsewhere; however, there are a few drawbacks:
- the popup does not show the page one will arrive at
- "Related changes" does gives the changes in the redirect page
- the redirect message on the new page slightly clutters it
On the other hand, one may prefer the link title to provide some information that is not in the name of the page one links to, such as the value of a unit in terms of other units. In that case one can make a page whose pagename is the info one wants in the link title, and which redirects to a page with a more appropriate name. See e.g. w:Template:Ft, containing [[30.48 cm|ft]], with the page w:30.48 cm redirecting to w:Foot (unit of length).
[edit] Automatic conversion of the wikitext (pipe trick)
If in a piped link the part after the "|" is left empty, it is converted to an abbreviated form of the page name on the left, as follows:
- if there is a colon in it, the leftmost colon and anything to the left of that is removed (this does not work for "MediaWiki User's Guide:" due to the apostrophe)
- if there is a text in parentheses at the end it will be removed
For example, the wikitext [[w:en:Pipe (computing)|]] is converted to [[w:en:Pipe (computing)|en:Pipe]], which is rendered as en:Pipe, and [[Help:Template|]] is converted to [[Help:Template|Template]], rendered as Template.
If there is nothing to abbreviate, i.e. there is no colon and there are no parentheses, then the link does not work at all, e.g. [[a|]].
Just like for the three or four tildes when signing on Talk pages and the use of subst, in a preview, the result already shows up in the preview itself, but the conversion in the edit box is not yet shown. Save and press Edit again to see the result of the conversion.
For links between language versions of Wikipedia and between language versions of Wiktionary, the pipe trick is either not applicable (if the link comes at the edge) or is limited in use because of the starting colon.
In some projects and some cases the pipe trick does not work and the piped link wikitext is not even rendered as a link.
[edit] Examples
*[[project:a (b)|]] *[[w:project:a (b)|]] *[[de:project:a (b)|]] *[[wiktionary:project:a (b)|]] *[[wiktionary:de:project:a (b)|]] *[[wikibooks:project:a (b)|]] *[[wikiquote:project:a (b)|]] *[[wikisource:project:a (b)|]]
produces
[edit] Syntax for external links
For external links a space is used instead of a pipe character; see Help:Editing. A general term used for both is also clean link.
[edit] See also
- w:Help:Pipe trick
- Link#Subpage_feature , which shows how to abbreviate subpage names. (The pipe trick doesn't work as expected for subpages, which some people consider a bug. )
